DescribeRiskCheckSummary
Description
call the DescribeRiskCheckSummary interface to view the summary information of cloud product configuration check results, including the number of detected risk items, risk rate, number of affected assets, last detection time, and statistical data of various types of detected items.
Request Method
POST
Request Path
/apsara/route/Sas/DescribeRiskCheckSummary
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
SourceIp | BODY | string | No | 1.2.3.4 | access the IP address of the source. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
Lang | BODY | string | No | zh | the language type of the request and receive message. zh: Chinese en: English |
version | BODY | string | No | 2016-01-01 | version of api |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
Status | string | pass | the status of the check item after the check is completed. pass: The check passes, indicating that the check item is normal. failed: If the check fails, the check item is at risk. |
CountByStatus | array | No sample value for this parameter. | check item result statistics. |
RequestId | string | 291B49F9-1685-4005-9D34-606B6F78740F | request ID of the result. |
DisabledRiskCount | integer | 0 | the number of checks that failed. |
RemainingTime | integer | 0 | estimated check time. |
PreviousCount | integer | 0 | the number of risk items last checked. |
Title | string | Identity authentication and permissions | the name of the check item category. |
EnabledRiskCount | integer | 3 | the number of check items that passed the check. |
Count | integer | 2 | Number of risk items checked. |
RiskCount | integer | 1 | number of risk items checked. |
RiskLevelCount | array | No sample value for this parameter. | check the number of each type of hazard level. high: high risk medium: medium risk low: low risk |
PreviousTime | long | 1545012926000 | last check time. |
Groups | array | No sample value for this parameter. | check statistics of item types. |
ItemCount | integer | 4 | the number of check items. |
RiskRate | float | 0.25 | the proportion of the number of risk items checked in the total number of items checked. |
Sort | integer | 1 | check item types in console all types the order in the drop-down list. |
Id | long | 1 | check item category ID. |
RiskCheckSummary | struct | No sample value for this parameter. | statistics on the results of cloud product configuration checks. |
AffectedAssetCount | integer | 0 | the number of assets affected by the risk item in the inspection result. |
Key | string | medium | the hazard level of the check item. |
Example
Successful Response example
{
"Status":"pass",
"CountByStatus":"",
"RequestId":"291B49F9-1685-4005-9D34-606B6F78740F",
"DisabledRiskCount":"0",
"RemainingTime":"0",
"PreviousCount":"0",
"Title":"Identity authentication and permissions",
"EnabledRiskCount":"3",
"Count":"2",
"RiskCount":"1",
"RiskLevelCount":"",
"PreviousTime":"1545012926000",
"Groups":"",
"ItemCount":"4",
"RiskRate":"0.25",
"Sort":"1",
"Id":"1",
"RiskCheckSummary":"",
"AffectedAssetCount":"0",
"Key":"medium"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}